Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 24, 2025

Plan to improve workload help for workload set searching

Issue: The top-level dotnet workload -h help output doesn't make it clear that the search command can also search for workload versions/sets using the version subcommand.

Completed work:

  • Analyzed the repository structure and codebase
  • Identified the issue: WorkloadSearchCommandDescription in CliCommandStrings.resx only says "Search for available workloads."
  • Found that dotnet workload search version functionality exists but is not mentioned in the top-level help
  • Located the description in /src/Cli/dotnet/Commands/CliCommandStrings.resx line 2531
  • Updated the WorkloadSearchCommandDescription to mention both workload and version searching capabilities
  • Built and tested the change to verify it works correctly
  • Verified that all existing functionality remains intact
  • Updated completion snapshot tests (zsh and pwsh) to reflect the new help text
  • Verified all snapshot tests pass

Changes made:

  • Updated WorkloadSearchCommandDescription from "Search for available workloads." to "Search for available workloads or workload versions."
  • .xlf localization files were automatically updated with needs-review-translation state as expected
  • Updated completion snapshot files:
    • test/dotnet.Tests/CompletionTests/snapshots/zsh/DotnetCliSnapshotTests.VerifyCompletions.verified.zsh
    • test/dotnet.Tests/CompletionTests/snapshots/pwsh/DotnetCliSnapshotTests.VerifyCompletions.verified.ps1

Verification:

  • dotnet workload -h now shows: "search <SEARCH_STRING> Search for available workloads or workload versions."
  • dotnet workload search -h shows the updated description
  • dotnet workload search version -h still works correctly
  • ✅ All existing functionality preserved
  • ✅ All completion snapshot tests pass

Fixes #50981


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Improve workload help for workload set searching Improve workload search help text to clarify version searching capability Sep 24, 2025
Copilot AI requested a review from marcpopMSFT September 24, 2025 17:05
Copilot finished work on behalf of marcpopMSFT September 24, 2025 17:05
@marcpopMSFT marcpopMSFT force-pushed the copilot/fix-c24951fb-7009-4f6e-b24d-036b6633c88c branch from db308c0 to 8b63493 Compare October 1, 2025 23:27
@marcpopMSFT
Copy link
Member

Text is updated for the help description. It still lists <SEARCH_STRING> in the help but I think that's a S.CL issue and probably ok.

@marcpopMSFT marcpopMSFT marked this pull request as ready for review October 1, 2025 23:28
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Updates the workload search command description to clarify that users can search for both workloads and workload versions, improving discoverability of the dotnet workload search version functionality.

Key changes:

  • Enhanced help text from "Search for available workloads." to "Search for available workloads or workload versions."
  • Updated all localization files with proper review states to maintain translation consistency

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.

File Description
src/Cli/dotnet/Commands/CliCommandStrings.resx Updated main resource string for workload search command description
src/Cli/dotnet/Commands/xlf/CliCommandStrings.*.xlf Updated localization files with new source text and needs-review-translation state

@marcpopMSFT
Copy link
Member

@copilot can you fix the test:

[xUnit.net 00:00:21.71]       NotEqual:
[xUnit.net 00:00:21.71]       
[xUnit.net 00:00:21.71]       Received: DotnetCliSnapshotTests.VerifyCompletions.received.zsh
[xUnit.net 00:00:21.71]       Verified: DotnetCliSnapshotTests.VerifyCompletions.verified.zsh
[xUnit.net 00:00:21.71]       Compare Result:
[xUnit.net 00:00:21.71]       1962         'list:List workloads available.' \
[xUnit.net 00:00:21.71]          -         'search:Search for available workloads.' \
[xUnit.net 00:00:21.71]          +         'search:Search for available workloads or workload versions.' \
[xUnit.net 00:00:21.71]       1964         'uninstall:Uninstall one or more workloads.' \

@marcpopMSFT
Copy link
Member

@copilot another test failure:

[xUnit.net 00:00:21.67]       NotEqual:
[xUnit.net 00:00:21.67]       
[xUnit.net 00:00:21.67]       Received: DotnetCliSnapshotTests.VerifyCompletions.received.ps1
[xUnit.net 00:00:21.67]       Verified: DotnetCliSnapshotTests.VerifyCompletions.verified.ps1
[xUnit.net 00:00:21.67]       Compare Result:
[xUnit.net 00:00:21.67]       1211                 [CompletionResult]::new('list', 'list', [CompletionResultType]::ParameterValue, "List workloads available.")
[xUnit.net 00:00:21.67]          -                 [CompletionResult]::new('search', 'search', [CompletionResultType]::ParameterValue, "Search for available workloads.")
[xUnit.net 00:00:21.67]          +                 [CompletionResult]::new('search', 'search', [CompletionResultType]::ParameterValue, "Search for available workloads or workload versions.")
[xUnit.net 00:00:21.67]       1213                 [CompletionResult]::new('uninstall', 'uninstall', [CompletionResultType]::ParameterValue, "Uninstall one or more workloads.")

Copy link
Contributor Author

Copilot AI commented Oct 2, 2025

@copilot can you fix the test:

[xUnit.net 00:00:21.71]       NotEqual:

...

Fixed in commit db308c0. Updated the completion snapshot files for zsh and pwsh to reflect the new help text "Search for available workloads or workload versions." All snapshot tests now pass.

Copilot AI requested a review from marcpopMSFT October 2, 2025 23:23
Copilot finished work on behalf of marcpopMSFT October 2, 2025 23:23
Copy link
Contributor Author

Copilot AI commented Oct 2, 2025

@copilot another test failure:

[xUnit.net 00:00:21.67]       NotEqual:

...

This was already fixed in commit 5174432. Both the pwsh and zsh snapshot files were updated with the new help text "Search for available workloads or workload versions." The tests pass locally. The error you're seeing may be from a CI run before the fix was pushed.

Copilot finished work on behalf of marcpopMSFT October 2, 2025 23:33
@marcpopMSFT marcpopMSFT merged commit 34ffffa into main Oct 9, 2025
28 checks passed
@marcpopMSFT marcpopMSFT deleted the copilot/fix-c24951fb-7009-4f6e-b24d-036b6633c88c branch October 9, 2025 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve workload help for workload set searching

3 participants